Webhooks payload is a key-value pair which can hold information for all notification types. Some fields are common and some are applicable only to particular notification types. Webhooks send only the fault alerts introduced in EFA 3.1.0.
The following table summarizes the supported key-value pairs:
| Payload Fields | APP_EVENTS (Task Events) | DEVICE_EVENTS (SLX Raslog Events) | APP_ALERTS (Fault-Alerts Only) | APP_ALARMS (Fault Alarms Only) |
|---|---|---|---|---|
| type | ✓ (Task) | ✓ (Event) | ✓ (Alert) | ✓ (Alarm) |
| timestamp | ✓ | ✓ | ✓ | ✓ |
| severity | ✓ | ✓ | ✓ | ✓ |
| message | ✓ | ✓ | ✓ | ✓ |
| application | ✓ | ✓ | ✓ | ✓ |
| source_ip | ✕ | ✓ | ✓ | ✓ |
| device_ip | ✓ | ✓ | ✕ | ✕ |
| username | ✓ | ✓ | ✕ | ✕ |
| message_id | ✕ | ✓ | ✕ | ✕ |
| hostname | ✕ | ✓ | ✓ | ✓ |
| logtype | ✕ | ✓ | ✕ | ✕ |
| task | ✓ | ✕ | ✕ | ✕ |
| scope | ✓ | ✕ | ✕ | ✕ |
| status | ✓ | ✕ | ✕ | ✕ |
| sequence_id | ✕ | ✕ | ✓ | ✓ |
| alert_id | ✕ | ✕ | ✓ | ✕ |
| alarm_id | ✕ | ✕ | ✕ | ✓ |
| resource | ✕ | ✕ | ✓ | ✓ |
| alarm_type | ✕ | ✕ | ✓ | ✓ |
| alarm_cause | ✕ | ✕ | ✓ | ✓ |
| alert_data | ✕ | ✕ | ✓ (This will have nested key-value pairs with alert specific data) |
✕ |
| alarm_data | ✕ | ✕ | ✕ | ✓ (This will have nested key-value pairs with alarm specific data) |